Authenticate User with SAML Authentication

Generates a Pyramid access authentication token using SAML authentication tokens

Method

/API2/auth/authenticateUserSAML

  • API Section: /API2/auth
  • API Version: 2.0
  • From Release: 2020.13
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
    • Domain Admin
    • Pro
    • Analyst
    • Viewer
    • Basic

Method Signature

Input Parameters

Name

token

Object Type

BaseUserSamlCredentials

Description

The user credentials for authentication by SAML token.

Output Response

Successful Result Code

200

Response Type

string

Description of Response Type

The response is the security token as a base64 string. It is usually stored in a cookie.

Notes

The security token is a string that needs to be embedded in every API call to ensure the API calls are authorized. If saved as a cookie in a web browser, it can be used (for the authenticated user) to auto-login into the application. The assumption is that the user has already authenticated via SAML before attempting to authenticate into Pyramid.